mouse

Type

function

Summary

Returns the state of a mouse button.

Syntax

mouse([<buttonNumber>])

the mouse

Description

Use the mouse function to check whether the user is pressing a mouse button.

If you don't specify a buttonNumber, the mouse function returns the state of mouse button 1.

Parameters

Name	Type	Description
buttonNumber	enum	The buttonNumber specifies which mouse button to check: 1 is the mouse button on Mac OS systems and the left button on Windows and Unix systems. - 2 is the middle button on Unix systems. - 3 is the right button on Windows and Unix systems and Control-click on Mac OS systems.

Examples

the mouse

mouse(3)

if mouse(defaultButton) is "up" then
  goBackToStart
end if

Related

constant: left

function: mouseClick

glossary: mouse button, return

message: mouseDoubleUp, mouseStillDown

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

Platforms

desktop

server